InsuranceNow API (5.0.0)
InsuranceNow's RESTful API is built according to the OpenAPI specification and provides access to InsuranceNow functionality. Developers can use the API to integrate InsuranceNow with portals and other third-party systems.
Lists quotes or applications.
Returns a list of quotes or applications.
query Parameters
applicationOrQuoteNumber | string Application or quote number |
continuationId | string Indicates the starting offset for the API results when you want to return a specific portion of the full results.
You can use this parameter with the limit parameter.
For example, the limit on your first API call was 100 and the results populated a list on the page.
To request the next page of 100 results, call the API again with |
createdSinceDate | string <date> Select applications where application creation date is equal to or greater than the provided createdSinceDate. |
customerId | string Customer ID number |
includeClosed | boolean Includes closed applications.
|
includeDeleted | boolean Includes deleted applications.
|
limit | string For pagination -- the maximum number of results to return. |
optionalFields | string Comma-delimited list of optional fields to be included. Currently supports customer and product. |
policyId | string Policy ID |
providerId | string Provider code number |
recentlyViewed | boolean Finds applications recently viewed by the caller/user.
|
status | string Application status (e.g. In Process) |
transactionCd | string Transaction code (e.g. New Business) Use where a specific transactionCd(s) is known. Accepts a comma-separated list of values. Ignored when transactionCdGroup contains a value. |
transactionCdGroup | string Find applications by transactionCdGroup. Use when a specific transactionCd(s) is not known. Accepts a comma-separated list of values. Valid values are Quote, Cancellation, Renewal, or Other. |
type | string Application type. Valid values are Application, QuickQuote, or Quote. |
Responses
Response samples
- 200
- 400
- 500
{- "applicationListItems": [
- {
- "_links": [
- {
- "href": "string",
- "rel": "string"
}
], - "applicationMini": {
- "_links": [
- {
- "href": "string",
- "rel": "string"
}
], - "applicationInfo": {
- "addDt": "2019-08-24",
- "addTm": "string",
- "addUser": "string",
- "closeComment": "string",
- "closeDt": "2019-08-24",
- "closeReasonCd": "string",
- "closeSubReasonCd": "string",
- "closeSubReasonLabel": "string",
- "closeTm": "string",
- "closeUser": "string",
- "correctedByTransactionNumber": 0,
- "correctionOfTransactionNumber": 0,
- "firstMailedDt": "2019-08-24",
- "id": "string",
- "iterationDescription": "string",
- "lastMailedDt": "2019-08-24",
- "masterQuoteRef": "string",
- "needByDt": "2019-08-24",
- "pendForReleaseInd": true,
- "reinstatedByTransactionNumber": 0,
- "reinstatementOfTransactionNumber": 0,
- "renewalApplyInd": true,
- "renewalApplyOfTransactionNumber": 0,
- "submittedDt": "2019-08-24",
- "updateDt": "2019-08-24",
- "updateTm": "string",
- "updateUser": "string"
}, - "applicationNumber": "string",
- "auditAccountRef": "string",
- "basicPolicy": {
- "affinityGroupCd": "string",
- "branch": "string",
- "businessSourceCd": "string",
- "cALineSelectedInd": true,
- "cAPolicyType": "string",
- "cCLineSelectedInd": true,
- "cGLineSelectedInd": true,
- "cILineSelectedInd": true,
- "cLLineSelectedInd": true,
- "cPLineSelectedInd": true,
- "cPPolicyType": "string",
- "cancelDt": "2019-08-24",
- "carrierCd": "string",
- "carrierGroupCd": "string",
- "changeDt": "2019-08-24",
- "chrgHLS": "string",
- "chrgWSC": "string",
- "commCLUERequestInd": true,
- "comments": "string",
- "companyProductCd": "string",
- "controllingStateCd": "string",
- "dPLineSelectedInd": true,
- "description": "string",
- "directorsAndOfficersLineSelectedInd": true,
- "discHAC": "string",
- "discHCFC": "string",
- "discLFC": "string",
- "discNH": "string",
- "discNHBC": "string",
- "discPDC": "string",
- "discRC": "string",
- "displayDescription": "string",
- "effectiveDt": "2019-08-24",
- "effectiveTm": "12:01am",
- "employmentAndPracticeLineSelectedInd": true,
- "errorsAndOmissionLineSelectedInd": true,
- "expirationDt": "2019-08-24",
- "expiringFeeAmt": "string",
- "expiringPremiumAmt": "string",
- "extendedCoverageInd": true,
- "externalId": "string",
- "farmAutoDiscountInd": true,
- "farmAutoDiscountPolicy": "string",
- "farmTypeBasic": "string",
- "farmTypeCattleInd": true,
- "farmTypeDairyInd": true,
- "farmTypeFarmetteInd": true,
- "farmTypeGrainInd": true,
- "finalPremiumAmt": "string",
- "fireLightningInd": true,
- "fullTermAmt": "string",
- "gLLineSelectedInd": true,
- "iSOFireLinePrevAddrHash": "string",
- "id": "string",
- "inceptionDt": "2019-08-24",
- "inceptionTm": "12:01am",
- "latestTerm": "string",
- "latestTermTransaction": "string",
- "legacyPolicyNumber": "string",
- "llcOwnedDt": "2019-08-24",
- "lossSettlementType": "string",
- "manualReinstateInd": true,
- "manualReinstateReason": "string",
- "manualRenewalInd": true,
- "manualRenewalReason": "string",
- "namedNonOwnedInd": true,
- "nonRenewInd": true,
- "originalApplicationRef": "string",
- "pLLineSelectedInd": true,
- "payPlanCd": "string",
- "paymentDay": "string",
- "policyDisplayNumber": "string",
- "policyForm": "string",
- "policyNumber": "string",
- "policySource": "string",
- "policyType": "string",
- "policyVersion": "001",
- "previousCarrierCd": "string",
- "previousExpirationDt": "2019-08-24",
- "previousPolicyNumber": "string",
- "previousPremium": "string",
- "priorCarrier": "string",
- "productTypeCd": "string",
- "productVersionIdRef": "string",
- "programCd": "string",
- "promotionCd": "string",
- "providerRef": "string",
- "quoteNumber": "string",
- "quoteNumberLookup": "string",
- "ratedInd": true,
- "reinstateDt": "2019-08-24",
- "renewalPolicyRef": "string",
- "renewalProviderRef": "string",
- "renewalSubProducerCd": "string",
- "renewalTermCd": "string",
- "renewedFromPolicyRef": "string",
- "replacedByPolicyRef": "string",
- "rewriteFromPolicyRef": "string",
- "rewritePolicyRef": "string",
- "sessionLink": "string",
- "shellPolicyInd": true,
- "sicCode": "string",
- "splitLevelPCVal": "string",
- "statusCd": "string",
- "subProducerCd": "string",
- "subTypeCd": "string",
- "transactionCd": "string",
- "transactionHistory": [
- {
- "applicationRef": "string",
- "bookDt": "2019-08-24",
- "cancelOfTransactionNumber": 0,
- "cancelRequestedByCd": "string",
- "cancelTypeCd": "string",
- "cancelledByTransactionNumber": 0,
- "chargeReinstatementFeeInd": true,
- "checkNumber": "string",
- "conversionGroup": "string",
- "conversionJobRef": "string",
- "conversionTemplateIdRef": "string",
- "correctedByTransactionNumber": 0,
- "correctionOfTransactionNumber": 0,
- "delayInvoiceInd": true,
- "electronicPaymentSource": {
- "achBankAccountNumber": "string",
- "achBankAccountTypeCd": "string",
- "achBankName": "string",
- "achExceptionMsg": "string",
- "achName": "string",
- "achRoutingNumber": "string",
- "achStandardEntryClassCd": "string",
- "action": "string",
- "agentTrustInd": true,
- "carrierCd": "string",
- "creditCardAuthorizationCd": "string",
- "creditCardAuthorizationMessage": "string",
- "creditCardExpirationMonth": "string",
- "creditCardExpirationYr": "string",
- "creditCardHolderName": "string",
- "creditCardNumber": "string",
- "creditCardSecurityCd": "string",
- "creditCardTypeCd": "string",
- "customerPaymentProfileId": "string",
- "customerProfileId": "string",
- "eraseInfo": {
- "erasedBy": "string",
- "erasedDt": "2019-08-24",
- "erasedInd": true,
- "erasedTm": "string",
- "id": "string"
}, - "id": "string",
- "methodCd": "string",
- "midasId": "string",
- "partyInfo": {
- "addresses": [
- null
], - "emailInfo": {
- "emailAddr": null,
- "emailTypeCd": null,
- "id": null,
- "preferredInd": null
}, - "eraseInfo": {
- "erasedBy": null,
- "erasedDt": null,
- "erasedInd": null,
- "erasedTm": null,
- "id": null
}, - "id": "string",
- "nameInfo": {
- "commercialName": null,
- "commercialName2": null,
- "dbaIndexName": null,
- "dbaName": null,
- "extendedName": null,
- "givenName": null,
- "id": null,
- "indexName": null,
- "nameTypeCd": null,
- "otherGivenName": null,
- "positionCd": null,
- "prefixCd": null,
- "shortName": null,
- "suffixCd": null,
- "surname": null
}, - "partyTypeCd": "ContactParty"
}, - "paymentServiceAccountId": "string",
- "reminderDt": "2019-08-24",
- "sourceName": "string",
- "sourceTypeCd": "string",
- "statusCd": "string",
- "transactionId": "string"
}, - "holdType": "string",
- "id": "string",
- "inforceChangePremiumAmt": "string",
- "inforcePremiumAmt": "string",
- "masterTransactionNumber": 0,
- "newPolicyEffectiveDt": "2019-08-24",
- "newPolicyExpirationDt": "2019-08-24",
- "outputTypeCd": "string",
- "paymentAmt": "string",
- "paymentTypeCd": "string",
- "reapplyOutputSuppress": [
- {
- "description": "string",
- "effectiveDt": "2019-08-24",
- "id": "string",
- "include": [
- null
], - "includeInd": true,
- "policyVersion": 0,
- "transactionNumber": 0,
- "transactionText": [
- null
]
}
], - "reinstatedByTransactionNumber": 0,
- "reinstatementOfTransactionNumber": 0,
- "releaseHoldReason": "string",
- "renewalApplyOfTransactionNumber": 0,
- "renewalProviderRef": "string",
- "renewalSubProducerCd": "string",
- "replacedByTransactionNumber": 0,
- "replacementOfTransactionNumber": 0,
- "rewriteToProductVersion": "string",
- "sourceCd": "string",
- "submissionNumber": 0,
- "transactionCd": "string",
- "transactionCloseReasons": {
- "closeComment": "string",
- "closeReasonCd": "string",
- "closeSubReasonCd": "string",
- "closeSubReasonLabel": "string",
- "id": "string"
}, - "transactionDt": "2019-08-24",
- "transactionEffectiveDt": "2019-08-24",
- "transactionEffectiveTm": "string",
- "transactionLongDescription": "string",
- "transactionNumber": 0,
- "transactionReasons": [
- {
- "id": "string",
- "reasonCd": "string"
}
], - "transactionShortDescription": "string",
- "transactionText": [
- {
- "id": "string",
- "text": "string",
- "textCd": "string",
- "transactionTextTypeCd": "string"
}
], - "transactionTm": "string",
- "transactionUser": "string",
- "unAppliedByTransactionNumber": 0,
- "unApplyOfTransactionNumber": 0,
- "unapplySource": "string",
- "wcReinstatementCd": "string",
- "wcTotalNetLocationsManualPremiumAmt": "string",
- "wcWaiveCancellationAuditInd": true,
- "writtenChangePremiumAmt": "string",
- "writtenFeeAmt": "string",
- "writtenPremiumAmt": "string"
}
], - "transactionNumber": 0,
- "transactionStatus": "string",
- "underwriterCd": "string",
- "underwritingHoldInd": true,
- "vandalismMaliciousMischiefInd": true,
- "writtenFeeAmt": "string",
- "writtenPremiumAmt": "string"
}, - "customerRef": "string",
- "description": "string",
- "exportFilename": "string",
- "id": "string",
- "insured": {
- "entityTypeCd": "string",
- "id": "string",
- "indexName": "string",
- "partyInfo": [
- {
- "addresses": [
- {
- "addition": "string",
- "additionalLegal": "string",
- "addr1": "string",
- "addr2": "string",
- "addr3": "string",
- "addr4": "string",
- "addrTypeCd": "ContactAddr",
- "addressHash": "string",
- "attention": "string",
- "barcodeDigits": "string",
- "block": "string",
- "carrierRoute": "string",
- "city": "string",
- "congressCode": "string",
- "county": "string",
- "countyCode": "string",
- "dpv": "string",
- "dpvDesc": "string",
- "dpvNotes": "string",
- "dpvNotesDesc": "string",
- "geocodeLevel": "string",
- "geocodeLevelDescription": "string",
- "id": "string",
- "latitude": "string",
- "legalDesc": "string",
- "longitude": "string",
- "lot": "string",
- "meridian": "string",
- "plssCounty": "string",
- "postDirectional": "string",
- "postalCode": "string",
- "preDirectional": "string",
- "primaryMeridian": "string",
- "primaryNumber": "string",
- "primaryNumberSuffix": "string",
- "range": "string",
- "rangeDir": "string",
- "regionCd": "string",
- "regionISOCd": "string",
- "score": "string",
- "secondaryDesignator": "string",
- "secondaryNumber": "string",
- "section": "string",
- "stateProvCd": "string",
- "streetName": "string",
- "suffix": "string",
- "township": "string",
- "townshipDir": "string",
- "validated": "string",
- "verificationHash": "string",
- "verificationMsg": "string"
}
], - "businessInfo": {
- "annualPayrollAmt": "string",
- "annualSalesAmt": "string",
- "businessInfoCd": "ContactBusiness",
- "businessTypeCd": "string",
- "id": "string",
- "natureBusinessCd": "string",
- "natureOfBusiness": "string",
- "numberEmployees": "string",
- "yearsInBusiness": "string"
}, - "emailInfo": {
- "emailAddr": "string",
- "emailTypeCd": "ContactEmail",
- "id": "string",
- "preferredInd": false
}, - "eraseInfo": {
- "erasedBy": "string",
- "erasedDt": "2019-08-24",
- "erasedInd": true,
- "erasedTm": "string",
- "id": "string"
}, - "id": "string",
- "issues": [
- {
- "attributeRefs": [
- null
], - "id": "string",
- "msg": "string",
- "subTypeCd": "string",
- "typeCd": "string"
}
], - "locationIdRef": "string",
- "nameInfo": {
- "commercialName": "string",
- "commercialName2": "string",
- "dbaIndexName": "string",
- "dbaName": "string",
- "extendedName": "string",
- "givenName": "string",
- "id": "string",
- "indexName": "string",
- "nameTypeCd": "ContactName",
- "otherGivenName": "string",
- "positionCd": "string",
- "prefixCd": "Ms",
- "shortName": "string",
- "suffixCd": "string",
- "surname": "string"
}, - "partyTypeCd": "ContactParty",
- "personInfo": {
- "age": 0,
- "ageLicensed": 0,
- "bestTimeToContact": "string",
- "bestWayToContact": "string",
- "birthDt": "2019-08-24",
- "educationCd": "string",
- "employerCd": "string",
- "genderCd": "string",
- "id": "string",
- "impairmentDesc": "string",
- "impairmentInd": true,
- "maritalStatusCd": "string",
- "occupationCd": "string",
- "occupationClassCd": "string",
- "personTypeCd": "ContactPersonal",
- "positionTitle": "string",
- "yearsLicensed": 0
}, - "phoneInfo": [
- {
- "id": "string",
- "phoneName": "string",
- "phoneNumber": "string",
- "phoneTypeCd": "ContactPhone",
- "preferredInd": false
}
], - "taxInfo": {
- "fein": "string",
- "id": "string",
- "legalEntityCd": "string",
- "received1099Ind": true,
- "receivedW9Ind": true,
- "required1099Ind": true,
- "ssn": "string",
- "taxIdTypeCd": "FEIN",
- "taxTypeCd": "ContactTaxInfo",
- "withholdingExemptInd": true
}, - "underLyingPartyInfoIdRef": "string",
- "underLyingPolicyIdRef": "string",
- "yearsOfService": 0
}
], - "preferredDeliveryMethod": "string",
- "ratingBureauID": "string",
- "selfInsured": true,
- "temporaryAddressOverrideInd": true,
- "wcNAICS": "string",
- "wcNCCIRiskIdNumber": "string",
- "wcSIC": "string",
- "websiteAddress": "string",
- "yearsInBusiness": 0
}, - "lockTaskId": "string",
- "policyRef": "string",
- "statementAccountRef": "string",
- "status": "NewSubmission",
- "systemId": "string",
- "transactionInfo": {
- "bookDt": "2019-08-24",
- "cancelOfTransactionNumber": 0,
- "cancelRequestedByCd": "string",
- "cancelTypeCd": "string",
- "cancelledByTransactionNumber": 0,
- "chargeReinstatementFeeInd": true,
- "checkNumber": "string",
- "conversionGroup": "string",
- "conversionJobRef": "string",
- "conversionTemplateIdRef": "string",
- "correctedByTransactionNumber": 0,
- "correctionOfTransactionNumber": 0,
- "delayInvoiceInd": true,
- "holdType": "string",
- "id": "string",
- "masterTransactionNumber": 0,
- "newPolicyEffectiveDt": "2019-08-24",
- "newPolicyExpirationDt": "2019-08-24",
- "outputTypeCd": "string",
- "paymentAmt": "string",
- "paymentTypeCd": "string",
- "reinstatedByTransactionNumber": 0,
- "reinstatementOfTransactionNumber": 0,
- "releaseHoldReason": "string",
- "renewalApplyOfTransactionNumber": 0,
- "renewalProviderRef": "string",
- "renewalSubProducerCd": "string",
- "replacementOfTransactionNumber": 0,
- "rewriteToProductVersion": "string",
- "sourceCd": "Innovation",
- "statusChanges": [
- {
- "id": "string",
- "statusCd": "string",
- "statusDt": "2019-08-24"
}
], - "submissionNumber": 0,
- "transactionCd": "string",
- "transactionDt": "2019-08-24",
- "transactionEffectiveDt": "2019-08-24",
- "transactionEffectiveTm": "string",
- "transactionLongDescription": "string",
- "transactionNumber": 0,
- "transactionShortDescription": "string",
- "transactionTm": "string",
- "transactionUser": "string",
- "unApplyOfTransactionNumber": 0,
- "unapplySource": "string",
- "wcReinstatementCd": "string",
- "wcTotalNetLocationsManualPremiumAmt": "string",
- "wcWaiveCancellationAuditInd": true
}, - "typeCd": "string",
- "version": "3.20",
- "vipLevel": "string"
}, - "canEdit": true,
- "canInquiry": true,
- "currentOwner": "string",
- "customerInfo": {
- "customerNumber": "string",
- "customerRef": "string",
- "id": "string",
- "name": "string"
}, - "productInfo": {
- "id": "string",
- "name": "string"
}, - "ref": "string"
}
], - "continuationId": "string"
}
Was this page helpful?